Enriching software architecture documentation

نویسندگان

Anton Jansen

Paris Avgeriou

Jan Salvador van der Ven

چکیده

The effective documentation of Architectural Knowledge (AK) is one of the key factors in leveraging the paradigm shift toward sharing and reusing AK. However, current documentation approaches have severe shortcomings in capturing the knowledge of large and complex systems and subsequently facilitating its usage. In this paper, we propose to tackle this problem through the enrichment of traditional architectural documentation with formal AK. We have developed an approach consisting of a method and an accompanying tool suite to support this enrichment. We evaluate our approach through a quasi-controlled experiment with the architecture of a real, large, and complex system. We provide emperical evidence that our approach helps to partially solve the problem and indicate further directions in managing documented AK.

برای دانلود متن کامل این مقاله و بیش از 32 میلیون مقاله دیگر ابتدا ثبت نام کنید

ثبت نام

اگر عضو سایت هستید لطفا وارد حساب کاربری خود شوید

منابع مشابه

Enriching OSGi Service Interfaces with Formal Sequential Contracts

Architecture description languages define component interfaces with sequential contracts, which allow for static analysis of method call sequences in component or service interactions. However, component and service platforms like OSGi for Java do not provide mechanisms for the specification or enforcement of such sequential contracts. Thus the contracts are only defined in the documentation wh...

متن کامل

Unveiling Architecture Documentation: Brazilian Stakeholders in Perspective

Over the years, software architecture has become a established discipline, both in academia and industry, and the interest on software architecture documentation has increased. In this context, the improvement of methods, tools, and techniques around architecture documentation is of paramount importance. We conducted a survey with 147 industrial participants (31 from Brazil), analyzing their cu...

متن کامل

Understanding Software Architectures: Tracing architectural knowledge in software architecture documentation

Introduction " The reality is more excellent than the report. " – Ralph Waldo Emerson This thesis is about understanding software architecture documentation and how the integration of software architecture description and rationale can improve this understanding. Understanding software architecture (documentation) is important in the complete life cycle of a software architecture; during develo...

متن کامل

A Model Driven Approach for Automating Architecture Documentation Process

Software architecture documentation is a heavyweight process since it involves development and management of various documentation artifacts. Architectural views and architecture description languages (ADLs) are two examples of those artifacts each of which presents mostly similar information in different forms. So, there is a redundant documentation effort when two models are developed separat...

متن کامل